GET   https://api.d-tools.com/SI/Subscribe/PurchaseOrders?vendors[0]={vendors[0]}&vendors[1]={vendors[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}

Get purchase orders published by a SI user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vendors

Vendors to filter purchase orders (Optional)

Collection of string

None.

statuses

Statuses to filter purchase orders (Optional)

Collection of string

None.

includeImported

Boolean. Include already imported purchase orders. Optional with default value false which means by default you will only see purchase orders which are not imported.

boolean

Default value is False

searchText

The search text.

string

None.

includeDeleted

Boolean. Include purchase order deleted in SI. Optional with default value false which means by default you will only see active purchase orders which are not deleted.

boolean

Default value is False

pageNumber

The page number.

integer

Default value is 1

pageSize

The page size.

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

PurchaseOrdersResult
NameDescriptionTypeAdditional information
PurchaseOrders

Purchase orders array

Collection of PurchaseOrderInfo

None.

TotalCount

Total count of purchase order

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "PurchaseOrders": [
    {
      "Id": "sample string 1",
      "Vendor": "sample string 2",
      "Number": "sample string 3",
      "Status": "sample string 4",
      "ImportedOn": "2024-04-29T15:17:05.4900663+00:00",
      "PublishedOn": "2024-04-29T15:17:05.4900663+00:00",
      "Deleted": true
    },
    {
      "Id": "sample string 1",
      "Vendor": "sample string 2",
      "Number": "sample string 3",
      "Status": "sample string 4",
      "ImportedOn": "2024-04-29T15:17:05.4900663+00:00",
      "PublishedOn": "2024-04-29T15:17:05.4900663+00:00",
      "Deleted": true
    }
  ],
  "TotalCount": 1
}

application/xml, text/xml

Sample:
<PurchaseOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <PurchaseOrders>
    <PurchaseOrderInfo>
      <Deleted>true</Deleted>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T15:17:05.4900663+00:00</ImportedOn>
      <Number>sample string 3</Number>
      <PublishedOn>2024-04-29T15:17:05.4900663+00:00</PublishedOn>
      <Status>sample string 4</Status>
      <Vendor>sample string 2</Vendor>
    </PurchaseOrderInfo>
    <PurchaseOrderInfo>
      <Deleted>true</Deleted>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T15:17:05.4900663+00:00</ImportedOn>
      <Number>sample string 3</Number>
      <PublishedOn>2024-04-29T15:17:05.4900663+00:00</PublishedOn>
      <Status>sample string 4</Status>
      <Vendor>sample string 2</Vendor>
    </PurchaseOrderInfo>
  </PurchaseOrders>
  <TotalCount>1</TotalCount>
</PurchaseOrdersResult>